home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / program / mkutil21.zip / INSTALL.ME < prev   
Text File  |  1995-02-07  |  14KB  |  310 lines
  1.  
  2.         SciTech Software Distribution - Standard Directory Structure
  3.         ------------------------------------------------------------
  4.  
  5. This file describes the general directory structure of the SciTech Software
  6. programming libraries that you have installed. This directory structure
  7. is common to all SciTech Software products.
  8.  
  9. Where to get the latest releases
  10. --------------------------------
  11.  
  12. The latest releases of all SciTech Software products are always uploaded to
  13. the Simtel-20 MSDOS internet archives (oak.oakland.edu) and to various
  14. areas on CompuServe and America Online. However to obtain the obsolute
  15. latest release of all SciTech Software products, you can ftp them from
  16. our home site:
  17.  
  18.     ftp.scitechsoft.com (152.160.1.26)
  19.  
  20. If you wish to contact SciTech Software for feedback or bug reports on
  21. our products, you can do so as follows:
  22.  
  23. SciTech Software
  24. 5 Governors Lane, Suite D
  25. Chico, CA 95926 USA
  26.  
  27. Phone:          916-894-8400
  28. Fax:            510-208-8026
  29.  
  30. Internet:       rcskb@minyos.xx.rmit.edu.au
  31.                 support@scitechsoft.com
  32. Compuserve:     100237,2213
  33.  
  34. Find a nice home for it all
  35. ---------------------------
  36.  
  37. Before you install any of SciTech Software Products, you should decide upon
  38. a standard root directory for installing all of the products into. The
  39. default that we use is under the \SCITECH directory of one of our hard drives
  40. (in my case C:). Then you should install all the files for all the
  41. distributions that you have under the same directory tree. Many of the
  42. products use common libraries to get things done (like the PMODE library)
  43. and common header files. When you install them into the same directory
  44. you will only have one copy of each of these common files.
  45.  
  46. IMPORTANT: Once you decided on a root directory for installing your SciTech
  47.            Software Products, you should install them all into the same
  48.            directory. The command to do this with PKZIP would be (assuming
  49.            that all products are installed under C:\SCITECH):
  50.  
  51.                 pkunzip -d <zipfile>.zip C:\SCITECH
  52.  
  53.            This will correctly unzip all the archived files and create the
  54.            correct directory structure under the root directory C:\SCITECH
  55.  
  56.            Note that the '-d' command line option is essential to ensure
  57.            that the correct directory structure is built.
  58.  
  59. Installing for use
  60. ------------------
  61.  
  62. Once you have created the directory structure for the distribution, and
  63. all files have been installed, you will need to perform two final steps
  64. before you can use the libraries:
  65.  
  66.     1. Change your compilers default include path to include the
  67.        d:\SCITECH\INCLUDE directory so your compiler can find the required
  68.        include files, where d: is the drive that you have installed the
  69.        software onto.
  70.  
  71.     2. Change your compilers default library path to include the
  72.        d:\SCITECH\LIB\??? directory (substitute the correct sub-directory
  73.        name for your compiler - d:\SCITECH\LIB\BC3 is for Borland C++ 3.1).
  74.  
  75. Once you have done this, you can simply start using the library files as
  76. provided. If you intend to re-compile any of the libraries from the
  77. provided source code, you will need to follow the steps in the next
  78. section.
  79.  
  80. SciTech Software Common Makefile Utilities
  81. ------------------------------------------
  82.  
  83. In order to be able to re-compile any of the SciTech Software Distributions
  84. that come with source code, you will also need to install the SciTech
  85. Software Common Makefile Utilities package. This can be found in the
  86. archive called MKUTIL??.ZIP from the same location that you obtained this
  87. package from. This archive contains all of the relevant executable files
  88. (including a copy of DMAKE 3.8), batch files and DMAKE startup files
  89. required to re-compiled the source code for any of the supported compilers.
  90.  
  91. Once you have installed the files onto your hard drive, you will need to
  92. perform the following steps:
  93.  
  94.     1. Change the default executable file path in your AUTOEXEC.BAT file
  95.        to include the d:\SCITECH\BIN directory. This can be placed
  96.        anywhere in your path, so long as the DMAKE.EXE file in the BIN
  97.        directory will be found first (if there is another program with
  98.        the same name).
  99.  
  100.     2. Set the environment variables SCITECH and MGL_ROOT (if you are using
  101.        the MegaGraph Graphics Library). The batch file MGL_ENV.BAT in
  102.        the root \SCITECH directory is a sample of this. The SCITECH
  103.        environment variable is used by the batch files in the BIN
  104.        directory for setting up for compiling with a particular compiler,
  105.        and by the DMAKE program so that it can find all of the relevant
  106.        files during compilation.
  107.  
  108.     3. Set up the enivornment variables needed by the bacth files in the
  109.        next step, so that they can located your compilers executable files,
  110.        include files and library files. The file BIN\SET-VARS.BAT is an
  111.        example that we use, so you can start with this to build you own
  112.        batch file.
  113.  
  114.     4. Run the relevant batch file to set the environment up for your
  115.        compiler. The will file begin with a two letter prefix, and
  116.        end in either 16-VAR.BAT or 32-VAR.BAT (depending on whether you will
  117.        be compiling for 16 or 32 modes). These files require the SCITECH
  118.        environment variable to setup correctly, and the relevant variables
  119.        from the previous step to be set up correctly.
  120.  
  121. The following compilers are usually supported by SciTech Software, along with
  122. the code used by the batch files from step 4 above (some libraries may not
  123. support a particular compiled depending on lanuage requirements):
  124.  
  125.     bc3     - Borland C++ 3.1 16 bit
  126.     bc16    - Borland C++ 4.0 16 bit
  127.     bc32    - Borland C++ 4.0 32 bit
  128.     vc16    - Microsoft Visual C++ 1.5 16 bit
  129.     vc32    - Microsoft Visual C++ 1.0 32 bit
  130.     sc16    - Symantec C++ 6.1 16 bit
  131.     sc32    - Symantec C++ 6.1 32 bit
  132.     wc16    - Watcom C++ 10.0 16 bit
  133.     wc32    - Watcom C++ 10.0 32 bit
  134.     hc32    - Metaware High C/C++ 3.2
  135.     dj32    - DJGPP GNU C/C++ 32 bit
  136.  
  137. Once you have everything set up correctly, you should simply be able to
  138. type MAKE in any of the source directories and be in business.
  139.  
  140. Assembling 32 bit code
  141. ----------------------
  142.  
  143. All of SciTech Software's assembler code is written in Tasm IDEAL mode,
  144. so you will need a copy of Borland Tasm in order to re-assemble the assembler
  145. code. If you are assembling for 32 bit protected mode, you _MUST_ use
  146. Tasm 4.0 or later, since Tasm 3.1 and earlier do not generate correct 32
  147. bit code in some instances (pushing flags is one).
  148.  
  149. Compiling with Optimisations or for Debugging
  150. ---------------------------------------------
  151.  
  152. By default when you build the libraries, not optmisations and no debugging
  153. information is generated. You can turn either (or both) of these features
  154. on by setting the OPT or DBG variables for DMAKE. You can do this either
  155. by passing them on the command line, or setting them as environment
  156. variables:
  157.  
  158. dmake OPT=1 DBG=1
  159.  
  160. or
  161.  
  162. set OPT=1
  163. set DBG=1
  164. dmake
  165.  
  166. Changing the default structure packing alignment
  167. ------------------------------------------------
  168.  
  169. All SciTech Software libraries are compiled with the default structure
  170. packing alignment used by the compiler. If you wish to change the default
  171. structure packing alignment used by your compiler, you will need to
  172. recompile _all_ libraries that you use with the new compiler options.
  173. If you dont do this, our library code will be expecting the structures in
  174. a different format to that used by your code, causing some rather subtle
  175. and hard to find bugs!
  176.  
  177. Please note that it has been our experience that changing the default
  178. compiler packing alignment values is not a good idea for some compilers
  179. (because they dont bother to bracket their include files with #pragma pack!).
  180. Unless you know exactly what you are doing, we recommend you use the compiler
  181. defaults to ensure you dont get bitten by subtle alignment bugs.
  182.  
  183. Compiling with direct 80387+ floating point suppport
  184. ----------------------------------------------------
  185.  
  186. Many SciTech Software libraries can be compiled to use direct floating
  187. point support routines for 387+ co-processors in both 16 and 32 bit
  188. protected mode. Compiling with this option will turn on the compilers
  189. inline floating point instruction support, and will also enable any 387
  190. specific assembler modules that may be included. You can turn this on
  191. by setting the FPU variable for DMAKE, by either passing it on the command
  192. line or setting the evironment variable
  193.  
  194. dmake FPU=1
  195.  
  196. or
  197.  
  198. set FPU=1
  199. dmake
  200.  
  201. Programs compiled with this option will require an 387 or higher
  202. co-processor to be installed in the system (the 486DX and Pentium processors
  203. have an co-processor built in, while the 486SX does not). If you are
  204. compiling for real mode, and you system has a floating point emulator
  205. installed (such as Franke.387 or something similar) then the program will
  206. run as per normal. If you are compiling a 32 bit DOS extended application
  207. that is running under a DPMI environment that provides floating point
  208. emulation then your program will also run correctly (the Borland C++ DPMI32
  209. DOS extender provides this, as does the OS/2 2.x DOS box DPMI implementation).
  210.  
  211. Changing the default DOS Extender
  212. ---------------------------------
  213.  
  214. All of the SciTech Software libraries are DOS Extender independant. All
  215. DOS extender dependant information is encapsulated in the PMODE.LIB library.
  216. The default library provided for each of the compilers is compiled for
  217. the default DOS extender normally used by that compiler. All you need to
  218. do in order to use a different DOS extender is re-compile the PMODE
  219. library with the appropriate command line options, and then link with
  220. this new library. Refer to the documentation on the PMODE library for
  221. more details.
  222.  
  223. All SciTech Software distributions that require the PMODE library, come
  224. with a pre-compiled version of the library for the default DOS extender
  225. used by that compiler. If you wish to change the DOS extender, or you
  226. wish to have a look at the source code, you will need to obtain the
  227. PMODE library source archive. You should be able to get this from the
  228. same site that you downloaded this archive from as the file PMLITE??.ZIP.
  229.  
  230. Once you have re-compiled the PMODE library routines, you can change the
  231. DOS extender by either setting an environment variable (the easiest)
  232. or with command line parameters to DMAKE. The batch files provided in
  233. the SCITECH\BIN directory show how to set up for compiling and linking
  234. with any of the supported DOS extenders.
  235.  
  236. Setting up to use Phar Lap TNT
  237. ------------------------------
  238.  
  239. Notes on setting up TNT with each of the supported compilers should go in
  240. here.
  241.  
  242. Setting up to use FlashTek X-32
  243. -------------------------------
  244.  
  245. Symantec C++ 6.1
  246.  
  247. Setting up to use FlashTek X-32 or X-32VM with Symantec C++ is simple. If
  248. you only want to use the X-32 extender, you can follow the instructions in
  249. the file README.SC that comes on the X-32 distribution disks. However if
  250. you simply run the supplied SC32-X32.BAT batch file, it will place the
  251. appropriate X-32 library and include files before the normal Symantec
  252. ones, and you can selectively compile for either DOSX, X-32 or X-32VM.
  253.  
  254. Watcom C++ 10.0
  255.  
  256. Setting up to use FlashTek X-32 or X-32VM with Watcom C++ is simple. First
  257. you must ensure that you have the latest version (some new versions of X-32
  258. for Watcom 10.0 had interrupt handling problems - if you experience this
  259. obtain the latest version from FlashTek). Then you simply install the
  260. files as specified in the README.WTC that comes on the X-32 distribution
  261. disks. Watcom C++ 10.0 comes out of the box ready to compile with X-32 and
  262. X-32VM, so you can then start using the batch file WC32-X32.BAT and the
  263. WC32.MK DMAKE startup file to compile and link with X-32.
  264.  
  265. Directory tree
  266. --------------
  267.  
  268. The following is a brief outline of the directory tree, and the contents of
  269. all the sub-directories (note that not all of these will be present in
  270. every SciTech Software Distribution archive):
  271.  
  272. SCITECH             ROOT directory (SCITECH is default official name)
  273. │
  274. ├───BIN             Useful tools and batch files for library building
  275. │
  276. ├───DOC             Documentation files. Each individual product has its own
  277. │                   separate directory which contains all files specific to
  278. │                   that product.
  279. │
  280. ├───FONTS           All MGL font files installed here.
  281. │
  282. ├───BITMAPS         All MGL bitmap files installed here.
  283. │
  284. ├───CURSORS         All MGL mouse cursor files installed here.
  285. │
  286. ├───ICONS           All MGL icon files installed here.
  287. │
  288. ├───EXAMPLES        Any example source code. Separate sub-directories are
  289. │                   provided for each of the different products.
  290. │
  291. ├───MANIFEST        List of all files installed for each Distribution
  292. │
  293. ├───INCLUDE         All installed header files.
  294. │
  295. ├───LIB             All installed library files. Separate sub-directories are
  296. │   ├───BC16        provided for each of the different supported compilers.
  297. │   ├───...         These directories contain the pre-compiled versions of
  298. │   └───WC32        the library files ready for use.
  299. │
  300. ├───LIBSW           All installed shareware library files. In the shareware
  301. │   ├───BC16        distributions these directories contain pre-compiled
  302. │   ├───...         shareware versions of the library files ready for use.
  303. │   └───WC32
  304. │
  305. └───SRC             All source code for building the libraries (if provided).
  306.     ├───PMODE       Each package has a separate directory that contains all
  307.     ├───...         of the source code and makefiles for building the library
  308.     └───SVGAKIT     and installing it under \SCITECH\LIB.
  309.  
  310.